Simplify Network Broker config generation instructions#2418
Open
matthewdean-semgrep wants to merge 1 commit into
Open
Simplify Network Broker config generation instructions#2418matthewdean-semgrep wants to merge 1 commit into
matthewdean-semgrep wants to merge 1 commit into
Conversation
✅ Deploy Preview for semgrep-docs-prod ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
khorne3
approved these changes
Dec 3, 2025
Collaborator
khorne3
left a comment
There was a problem hiding this comment.
Just some nits. Thank you!
db96c29 to
bc62bed
Compare
Contributor
Author
|
@armchairlinguist Can you take a look? Resurrecting this old PR as we've run into additional cases where lack of simplified instructions made Broker setup more complicated than it need be. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The docs were written before we provided a starter config and before Network Broker supported fetching information like public key from DNS records. This updates the instructions for >v0.25.0 to omit unnecessary fields and streamline the setup. Note that this does create a dependence from Broker on DNS which previously did not exist so we want to carefully assess this change in recommendations.
As a side effect, this buries the explanation of how to manually generate Broker local addresses under the legacy section which is hidden by default.
Before:

After:
